<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pyactivemq.Message</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pyactivemq-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="pyactivemq-module.html">Module&nbsp;pyactivemq</a> ::
        Class&nbsp;Message
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="pyactivemq.Message-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Message</h1><p class="nomargin-top"></p>
<pre class="base-tree">
 object --+    
          |    
??.instance --+
              |
             <strong class="uidshort">Message</strong>
</pre>

<dl><dt>Known Subclasses:</dt>
<dd>
      <ul class="subclass-list">
<li><a href="pyactivemq.BytesMessage-class.html">BytesMessage</a></li><li>, <a href="pyactivemq.MapMessage-class.html">MapMessage</a></li><li>, <a href="pyactivemq.TextMessage-class.html">TextMessage</a></li>  </ul>
</dd></dl>

<hr />
<p>Root of all messages.</p>
  <p>As in JMS, a message is comprised of 3 parts: CMS-specific headers, 
  user-defined properties, and the body.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Raises an exception This class cannot be instantiated from Python</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#acknowledge" class="summary-sig-name">acknowledge</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Acknowledges all consumed messages of the session of this consumed message.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#clearBody" class="summary-sig-name">clearBody</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Clears out the body of the message.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#clearProperties" class="summary-sig-name">clearProperties</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Clears out the message body.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#getBooleanProperty" class="summary-sig-name">getBooleanProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Gets a boolean property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#getByteProperty" class="summary-sig-name">getByteProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Gets a byte property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#getDoubleProperty" class="summary-sig-name">getDoubleProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Gets a double property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#getFloatProperty" class="summary-sig-name">getFloatProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Gets a float property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#getIntProperty" class="summary-sig-name">getIntProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Gets a int property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#getLongProperty" class="summary-sig-name">getLongProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Gets a long property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#getShortProperty" class="summary-sig-name">getShortProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Gets a short property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#getStringProperty" class="summary-sig-name">getStringProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Gets a string property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#propertyExists" class="summary-sig-name">propertyExists</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Indicates whether or not a given property exists.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#setBooleanProperty" class="summary-sig-name">setBooleanProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Sets a boolean property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#setByteProperty" class="summary-sig-name">setByteProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Sets a byte property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#setDoubleProperty" class="summary-sig-name">setDoubleProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Sets a double property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#setFloatProperty" class="summary-sig-name">setFloatProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Sets a float property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#setIntProperty" class="summary-sig-name">setIntProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Sets a int property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#setLongProperty" class="summary-sig-name">setLongProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Sets a long property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#setShortProperty" class="summary-sig-name">setShortProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Sets a short property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pyactivemq.Message-class.html#setStringProperty" class="summary-sig-name">setStringProperty</a>(<span class="summary-sig-arg">...</span>)</span><br />
      Sets a string property.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><i>unreachable</i>.instance</code></b>:
      <code>__new__</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyactivemq.Message-class.html#correlationID" class="summary-name">correlationID</a><br />
      The correlation ID for the message.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyactivemq.Message-class.html#deliveryMode" class="summary-name">deliveryMode</a><br />
      Gets the <a href="pyactivemq.DeliveryMode-class.html" 
      class="link">DeliveryMode</a> for this message.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyactivemq.Message-class.html#destination" class="summary-name">destination</a><br />
      Returns the <a href="pyactivemq.Destination-class.html" 
      class="link">Destination</a> object for this message.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyactivemq.Message-class.html#expiration" class="summary-name">expiration</a><br />
      Gets the message's expiration value.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyactivemq.Message-class.html#messageID" class="summary-name">messageID</a><br />
      The <code>messageID</code> header field contains a value that 
      uniquely identifies each message sent by a provider.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyactivemq.Message-class.html#priority" class="summary-name">priority</a><br />
      Gets the message priority level.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyactivemq.Message-class.html#propertyNames" class="summary-name">propertyNames</a><br />
      Retrieves the complete set of property names currently in this 
      message.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyactivemq.Message-class.html#redelivered" class="summary-name">redelivered</a><br />
      Gets an indication of whether this message is being redelivered.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyactivemq.Message-class.html#replyTo" class="summary-name">replyTo</a><br />
      The <a href="pyactivemq.Destination-class.html" 
      class="link">Destination</a> object to which a reply to this message 
      should be sent.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyactivemq.Message-class.html#timestamp" class="summary-name">timestamp</a><br />
      Gets the message timestamp.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pyactivemq.Message-class.html#type" class="summary-name">type</a><br />
      Sets the message type.
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">...</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <p>Raises an exception This class cannot be instantiated from Python</p>
  <dl class="fields">
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="acknowledge"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">acknowledge</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Acknowledges all consumed messages of the session of this consumed message.

All consumed CMS messages support the acknowledge method for use when a client has specified that its CMS session's consumed messages are to be explicitly acknowledged. By invoking acknowledge on a consumed message, a client acknowledges all messages consumed by the session that the message was delivered to.

Calls to acknowledge are ignored for both transacted sessions and sessions specified to use implicit acknowledgement modes.

A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge messages as an application-defined group (which is done by calling acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session.)

Messages that have been received but not acknowledged may be redelivered.
C++ signature:
    acknowledge(cms::Message {lvalue}) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="clearBody"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">clearBody</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Clears out the body of the message.

This does not clear the headers or properties.
C++ signature:
    clearBody(cms::Message {lvalue}) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="clearProperties"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">clearProperties</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Clears out the message body.

Clearing a message's body does not clear its header values or property entries.

If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.
C++ signature:
    clearProperties(cms::Message {lvalue}) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getBooleanProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getBooleanProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Gets a boolean property.
C++ signature:
    getBooleanProperty(cms::Message {lvalue}, std::string) -&gt; bool

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getByteProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getByteProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Gets a byte property.
C++ signature:
    getByteProperty(cms::Message {lvalue}, std::string) -&gt; unsigned char

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getDoubleProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getDoubleProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Gets a double property.
C++ signature:
    getDoubleProperty(cms::Message {lvalue}, std::string) -&gt; double

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getFloatProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getFloatProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Gets a float property.
C++ signature:
    getFloatProperty(cms::Message {lvalue}, std::string) -&gt; float

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getIntProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getIntProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Gets a int property.
C++ signature:
    getIntProperty(cms::Message {lvalue}, std::string) -&gt; int

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getLongProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getLongProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Gets a long property.
C++ signature:
    getLongProperty(cms::Message {lvalue}, std::string) -&gt; long long

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getShortProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getShortProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Gets a short property.
C++ signature:
    getShortProperty(cms::Message {lvalue}, std::string) -&gt; short

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getStringProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getStringProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Gets a string property.
C++ signature:
    getStringProperty(cms::Message {lvalue}, std::string) -&gt; std::string

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="propertyExists"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">propertyExists</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Indicates whether or not a given property exists.
C++ signature:
    propertyExists(cms::Message {lvalue}, std::string) -&gt; bool

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="setBooleanProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">setBooleanProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Sets a boolean property.
C++ signature:
    setBooleanProperty(cms::Message {lvalue}, std::string, bool) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="setByteProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">setByteProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Sets a byte property.
C++ signature:
    setByteProperty(cms::Message {lvalue}, std::string, unsigned char) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="setDoubleProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">setDoubleProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Sets a double property.
C++ signature:
    setDoubleProperty(cms::Message {lvalue}, std::string, double) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="setFloatProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">setFloatProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Sets a float property.
C++ signature:
    setFloatProperty(cms::Message {lvalue}, std::string, float) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="setIntProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">setIntProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Sets a int property.
C++ signature:
    setIntProperty(cms::Message {lvalue}, std::string, int) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="setLongProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">setLongProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Sets a long property.
C++ signature:
    setLongProperty(cms::Message {lvalue}, std::string, long long) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="setShortProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">setShortProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Sets a short property.
C++ signature:
    setShortProperty(cms::Message {lvalue}, std::string, short) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="setStringProperty"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">setStringProperty</span>(<span class="sig-arg">...</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Sets a string property.
C++ signature:
    setStringProperty(cms::Message {lvalue}, std::string, std::string) -&gt; void*

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="correlationID"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">correlationID</h3>
  <p>The correlation ID for the message.</p>
  <p>A client can use the <code>correlationID</code> header field to link 
  one message with another. A typical use is to link a response message 
  with its request message.</p>
  <p><code>correlationID</code> can hold one of the following:</p>
  <ul>
    <li>
      A provider-specific message ID
    </li>
    <li>
      An application-specific string
    </li>
    <li>
      A provider-native byte value
    </li>
  </ul>
  <p>Since each message sent by a CMS provider is assigned a message ID 
  value, it is convenient to link messages via message ID. All message ID 
  values must start with the '<code>ID:</code>' prefix.</p>
  <p>In some cases, an application (made up of several clients) needs to 
  use an application-specific value for linking messages. For instance, an 
  application may use <code>correlationID</code> to hold a value 
  referencing some external information. Application-specified values must 
  not start with the '<code>ID:</code>' prefix; this is reserved for 
  provider-generated message ID values.</p>
  <p>If a provider supports the native concept of correlation ID, a CMS 
  client may need to assign specific <code>correlationID</code> values to 
  match those expected by clients that do not use the CMS API. A byte value
  is used for this purpose. CMS providers without native correlation ID 
  values are not required to support byte values. The use of a byte value 
  for correlationID is non-portable.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="deliveryMode"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">deliveryMode</h3>
  <p>Gets the <a href="pyactivemq.DeliveryMode-class.html" 
  class="link">DeliveryMode</a> for this message.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="destination"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">destination</h3>
  <p>Returns the <a href="pyactivemq.Destination-class.html" 
  class="link">Destination</a> object for this message.</p>
  <p>The destination header field contains the destination to which the 
  message is being sent.</p>
  <p>When a message is sent, this field is ignored. After completion of the
  send or publish method, the field holds the destination specified by the 
  method.</p>
  <p>When a message is received, its <code>destination</code> value must be
  equivalent to the value assigned when it was sent.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="expiration"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">expiration</h3>
  <p>Gets the message's expiration value.</p>
  <p>When a message is sent, the expiration header field is left 
  unassigned. After completion of the send or publish method, it holds the 
  expiration time of the message. This is the sum of the time-to-live value
  specified by the client and the GMT at the time of the send or 
  publish.</p>
  <p>If the time-to-live is specified as zero, expiration is set to zero to
  indicate that the message does not expire.</p>
  <p>When a message's expiration time is reached, a provider should discard
  it.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="messageID"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">messageID</h3>
  <p>The <code>messageID</code> header field contains a value that uniquely
  identifies each message sent by a provider.</p>
  <p>When a message is sent, messageID can be ignored. When the send or 
  publish method returns, it contains a provider-assigned value.</p>
  <p>A messageID is a <code>String</code> value that should function as a 
  unique key for identifying messages in a historical repository. The exact
  scope of uniqueness is provider-defined. It should at least cover all 
  messages for a specific installation of a provider, where an installation
  is some connected set of message routers.</p>
  <p>All <code>messageID</code> values must start with the prefix 
  '<code>ID:</code>'. Uniqueness of message ID values across different 
  providers is not required.</p>
  <p>Since message IDs take some effort to create and increase a message's 
  size, some CMS providers may be able to optimize message overhead if they
  are given a hint that the message ID is not used by an application. By 
  setting the <a 
  href="pyactivemq.MessageProducer-class.html#disableMessageID" 
  class="link">MessageProducer.disableMessageID</a> method, a CMS client 
  enables this potential optimization for all messages sent by that message
  producer. If the CMS provider accepts this hint, these messages must have
  the message ID set to null; if the provider ignores the hint, the message
  ID must be set to its normal unique value.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="priority"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">priority</h3>
  <p>Gets the message priority level.</p>
  <p>The CMS API defines ten levels of priority value, with 0 as the lowest
  priority and 9 as the highest. In addition, clients should consider 
  priorities 0-4 as gradations of normal priority and priorities 5-9 as 
  gradations of expedited priority.</p>
  <p>The CMS API does not require that a provider strictly implements 
  priority ordering of messages; however, it should do its best to deliver 
  expedited messages ahead of normal messages.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="propertyNames"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">propertyNames</h3>
  <p>Retrieves the complete set of property names currently in this 
  message.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="redelivered"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">redelivered</h3>
  <p>Gets an indication of whether this message is being redelivered.</p>
  <p>If a client receives a message with the redelivered field set, it is 
  likely, but not guaranteed, that this message was delivered earlier but 
  that its receipt was not acknowledged at that time.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="replyTo"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">replyTo</h3>
  <p>The <a href="pyactivemq.Destination-class.html" 
  class="link">Destination</a> object to which a reply to this message 
  should be sent.</p>
  <p>The <code>replyTo</code> header field contains the destination where a
  reply to the current message should be sent. If it is null, no reply is 
  expected. The destination may be either a <a 
  href="pyactivemq.Queue-class.html" class="link">Queue</a> object or a <a 
  href="pyactivemq.Topic-class.html" class="link">Topic</a> object.</p>
  <p>Messages sent with a null <code>replyTo</code> value may be a 
  notification of some event, or they may just be some data the sender 
  thinks is of interest.</p>
  <p>Messages with a <code>replyTo</code> value typically expect a 
  response. A response is optional; it is up to the client to decide. These
  messages are called requests. A message sent in response to a request is 
  called a reply.</p>
  <p>In some cases a client may wish to match a request it sent earlier 
  with a reply it has just received. The client can use the <a 
  href="pyactivemq.Message-class.html#correlationID" 
  class="link">correlationID</a> header field for this purpose.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="timestamp"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">timestamp</h3>
  <p>Gets the message timestamp.</p>
  <p>The <code>timestamp</code> header field contains the time a message 
  was handed off to a provider to be sent. It is not the time the message 
  was actually transmitted, because the actual send may occur later due to 
  transactions or other client-side queueing of messages.</p>
  <p>When a message is sent, <code>timestamp</code> is ignored. When the 
  send or publish method returns, it contains a time value somewhere in the
  interval between the call and the return. The value is in the format of a
  normal millis time value in the Java programming language.</p>
  <p>Since timestamps take some effort to create and increase a message's 
  size, some CMS providers may be able to optimize message overhead if they
  are given a hint that the timestamp is not used by an application. By 
  setting <a 
  href="pyactivemq.MessageProducer-class.html#disableMessageTimeStamp" 
  class="link">MessageProducer.disableMessageTimeStamp</a>, a CMS client 
  enables this potential optimization for all messages sent by that message
  producer. If the CMS provider accepts this hint, these messages must have
  the timestamp set to zero; if the provider ignores the hint, the 
  timestamp must be set to its normal value.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="type"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">type</h3>
  <p>Sets the message type.</p>
  <p>Some CMS providers use a message repository that contains the 
  definitions of messages sent by applications. The <code>type</code> 
  header field may reference a message's definition in the provider's 
  repository.</p>
  <p>The CMS API does not define a standard message definition repository, 
  nor does it define a naming policy for the definitions it contains.</p>
  <p>Some messaging systems require that a message type definition for each
  application message be created and that each message specify its type. In
  order to work with such CMS providers, CMS clients should assign a value 
  to <code>type</code>, whether the application makes use of it or not. 
  This ensures that the field is properly set for those providers that 
  require it.</p>
  <p>To ensure portability, CMS clients should use symbolic values for 
  <code>type</code> that can be configured at installation time to the 
  values defined in the current provider's message repository. If string 
  literals are used, they may not be valid type names for some CMS 
  providers.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">...</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pyactivemq-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sat Sep 20 01:50:41 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
